/**
 * Copyright (c) 2009 blurredVision
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 * associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or 
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT 
 * OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef __GUI_BUTTONGROUP_H__
#define __GUI_BUTTONGROUP_H__

#pragma once
#include "Component.h"
#include "Button.h"

namespace gui {

/**
 * \ingroup coreGUI
 *
 * The ButtonGroup class.<br>
 * This acts as a grouping element for buttons. 
 * If the added buttons are RadioButtons, only one button will selected.
 *
 * \date 05-02-2007
 *
 * \author juckel
 *
 */
class GUI_EXPORT ButtonGroup :
	public gui::Component
{
public:
	ButtonGroup(void);
	virtual ~ButtonGroup(void);

	/// Add a button to the group
	void addButton(Button *button);

	/// Remove a button from the group
	void removeButton(Button *button);

	/// Set the selected button to the specified one
	void setSelected(Button *button);

	/// Return the selected button
	Button* getSelected() const;

	/// Draw the gui element
	virtual void draw();

	/// Return the type of the gui element
	virtual inline const int getGUIType() const { return GUI_BUTTONGROUP; }

protected:
	Button *m_pSelectedButton;
};

} // namespace

#endif
